home *** CD-ROM | disk | FTP | other *** search
/ Personal Computer World 2009 February / PCWFEB09.iso / Software / Linux / Kubuntu 8.10 / kubuntu-8.10-desktop-i386.iso / casper / filesystem.squashfs / usr / share / pyshared / uno.py < prev    next >
Text File  |  2008-10-15  |  13KB  |  363 lines
  1. #*************************************************************************
  2. #
  3. #   OpenOffice.org - a multi-platform office productivity suite
  4. #
  5. #   $RCSfile: uno.py,v $
  6. #
  7. #   $Revision: 1.8 $
  8. #
  9. #   last change: $Author: kz $ $Date: 2007/10/11 11:52:39 $
  10. #
  11. #   The Contents of this file are made available subject to
  12. #   the terms of GNU Lesser General Public License Version 2.1.
  13. #
  14. #
  15. #     GNU Lesser General Public License Version 2.1
  16. #     =============================================
  17. #     Copyright 2005 by Sun Microsystems, Inc.
  18. #     901 San Antonio Road, Palo Alto, CA 94303, USA
  19. #
  20. #     This library is free software; you can redistribute it and/or
  21. #     modify it under the terms of the GNU Lesser General Public
  22. #     License version 2.1, as published by the Free Software Foundation.
  23. #
  24. #     This library is distributed in the hope that it will be useful,
  25. #     but WITHOUT ANY WARRANTY; without even the implied warranty of
  26. #     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  27. #     Lesser General Public License for more details.
  28. #
  29. #     You should have received a copy of the GNU Lesser General Public
  30. #     License along with this library; if not, write to the Free Software
  31. #     Foundation, Inc., 59 Temple Place, Suite 330, Boston,
  32. #     MA  02111-1307  USA
  33. #
  34. #*************************************************************************
  35. import sys
  36.  
  37. import pyuno
  38. import __builtin__
  39.  
  40. # all functions and variables starting with a underscore (_) must be considered private
  41. # and can be changed at any time. Don't use them
  42. _g_ctx = pyuno.getComponentContext( )
  43. _g_delegatee = __builtin__.__dict__["__import__"]
  44.  
  45. def getComponentContext():
  46.     """ returns the UNO component context, that was used to initialize the python runtime.
  47.     """ 
  48.     return _g_ctx      
  49.  
  50. def getConstantByName( constant ):
  51.     "Looks up the value of a idl constant by giving its explicit name"
  52.     return pyuno.getConstantByName( constant )
  53.  
  54. def getTypeByName( typeName):
  55.     """ returns a uno.Type instance of the type given by typeName. In case the
  56.         type does not exist, a com.sun.star.uno.RuntimeException is raised.
  57.     """ 
  58.     return pyuno.getTypeByName( typeName )
  59.  
  60. def createUnoStruct( typeName, *args ):
  61.     """creates a uno struct or exception given by typeName. The parameter args may
  62.     1) be empty. In this case, you get a default constructed uno structure.
  63.        ( e.g. createUnoStruct( "com.sun.star.uno.Exception" ) )
  64.     2) be a sequence with exactly one element, that contains an instance of typeName.
  65.        In this case, a copy constructed instance of typeName is returned
  66.        ( e.g. createUnoStruct( "com.sun.star.uno.Exception" , e ) )
  67.     3) be a sequence, where the length of the sequence must match the number of
  68.        elements within typeName (e.g.
  69.        createUnoStruct( "com.sun.star.uno.Exception", "foo error" , self) ). The
  70.        elements with in the sequence must match the type of each struct element,
  71.        otherwise an exception is thrown.
  72.     """
  73.     return getClass(typeName)( *args )
  74.  
  75. def getClass( typeName ):
  76.     """returns the class of a concrete uno exception, struct or interface
  77.     """
  78.     return pyuno.getClass(typeName)
  79.  
  80. def isInterface( obj ):
  81.     """returns true, when obj is a class of a uno interface"""
  82.     return pyuno.isInterface( obj )
  83.  
  84. def generateUuid():
  85.     "returns a 16 byte sequence containing a newly generated uuid or guid, see rtl/uuid.h "
  86.     return pyuno.generateUuid()        
  87.  
  88. def systemPathToFileUrl( systemPath ):
  89.     "returns a file-url for the given system path"
  90.     return pyuno.systemPathToFileUrl( systemPath )
  91.  
  92. def fileUrlToSystemPath( url ):
  93.     "returns a system path (determined by the system, the python interpreter is running on)"
  94.     return pyuno.fileUrlToSystemPath( url )
  95.  
  96. def absolutize( path, relativeUrl ):
  97.     "returns an absolute file url from the given urls"
  98.     return pyuno.absolutize( path, relativeUrl )
  99.  
  100. def getCurrentContext():
  101.     """Returns the currently valid current context.
  102.        see http://udk.openoffice.org/common/man/concept/uno_contexts.html#current_context
  103.        for an explanation on the current context concept
  104.     """
  105.     return pyuno.getCurrentContext()
  106.  
  107. def setCurrentContext( newContext ):
  108.     """Sets newContext as new uno current context. The newContext must
  109.     implement the XCurrentContext interface. The implemenation should
  110.     handle the desired properties and delegate unknown properties to the
  111.     old context. Ensure to reset the old one when you leave your stack ...
  112.     see http://udk.openoffice.org/common/man/concept/uno_contexts.html#current_context
  113.     """
  114.     return pyuno.setCurrentContext( newContext )
  115.  
  116.         
  117. class Enum:
  118.     "Represents a UNO idl enum, use an instance of this class to explicitly pass a boolean to UNO" 
  119.     #typeName the name of the enum as a string
  120.     #value    the actual value of this enum as a string
  121.     def __init__(self,typeName, value):
  122.         self.typeName = typeName
  123.         self.value = value
  124.         pyuno.checkEnum( self )
  125.  
  126.     def __repr__(self):
  127.         return "<uno.Enum %s (%r)>" % (self.typeName, self.value)
  128.  
  129.     def __eq__(self, that):
  130.         if not isinstance(that, Enum):
  131.             return False
  132.         return (self.typeName == that.typeName) and (self.value == that.value)
  133.  
  134. class Type:
  135.     "Represents a UNO type, use an instance of this class to explicitly pass a boolean to UNO"
  136. #    typeName                 # Name of the UNO type
  137. #    typeClass                # python Enum of TypeClass,  see com/sun/star/uno/TypeClass.idl
  138.     def __init__(self, typeName, typeClass):
  139.         self.typeName = typeName
  140.         self.typeClass = typeClass
  141.         pyuno.checkType(self)
  142.     def __repr__(self):
  143.         return "<Type instance %s (%r)>" % (self.typeName, self.typeClass)
  144.  
  145.     def __eq__(self, that):
  146.         if not isinstance(that, Type):
  147.             return False
  148.         return self.typeClass == that.typeClass and self.typeName == that.typeName
  149.  
  150.     def __hash__(self):
  151.         return self.typeName.__hash__()
  152.  
  153. class Bool(object):
  154.     """Represents a UNO boolean, use an instance of this class to explicitly 
  155.        pass a boolean to UNO.
  156.        Note: This class is deprecated. Use python's True and False directly instead
  157.     """
  158.     def __new__(cls, value):
  159.         if isinstance(value, (str, unicode)) and value == "true":
  160.             return True
  161.         if isinstance(value, (str, unicode)) and value == "false":
  162.             return False
  163.         if value:
  164.             return True
  165.         return False
  166.  
  167. class Char:
  168.     "Represents a UNO char, use an instance of this class to explicitly pass a char to UNO"
  169.     # @param value pass a Unicode string with length 1
  170.     def __init__(self,value):
  171.         assert isinstance(value, unicode)
  172.         assert len(value) == 1
  173.         self.value=value
  174.  
  175.     def __repr__(self):
  176.         return "<Char instance %s>" % (self.value, )
  177.         
  178.     def __eq__(self, that):
  179.         if isinstance(that, (str, unicode)):
  180.             if len(that) > 1:
  181.                 return False
  182.             return self.value == that[0]
  183.         if isinstance(that, Char):        
  184.             return self.value == that.value
  185.         return False
  186.  
  187. # Suggested by Christian, but still some open problems which need to be solved first
  188. #
  189. #class ByteSequence(str):
  190. #
  191. #    def __repr__(self):
  192. #        return "<ByteSequence instance %s>" % str.__repr__(self)
  193.  
  194.     # for a little bit compatitbility; setting value is not possible as 
  195.     # strings are immutable
  196. #    def _get_value(self):
  197. #        return self
  198. #
  199. #    value = property(_get_value)        
  200.  
  201. class ByteSequence:
  202.     def __init__(self, value):
  203.         if isinstance(value, str):
  204.             self.value = value
  205.         elif isinstance(value, ByteSequence):
  206.             self.value = value.value
  207.         else:
  208.             raise TypeError("expected string or bytesequence")
  209.  
  210.     def __repr__(self):
  211.         return "<ByteSequence instance '%s'>" % (self.value, )
  212.  
  213.     def __eq__(self, that):
  214.         if isinstance( that, ByteSequence):
  215.             return self.value == that.value
  216.         if isinstance(that, str):
  217.             return self.value == that
  218.         return False
  219.  
  220.     def __len__(self):
  221.         return len(self.value)
  222.  
  223.     def __getitem__(self, index):
  224.         return self.value[index]
  225.  
  226.     def __iter__( self ):
  227.         return self.value.__iter__()
  228.  
  229.     def __add__( self , b ):
  230.         if isinstance( b, str ):
  231.             return ByteSequence( self.value + b )
  232.         elif isinstance( b, ByteSequence ):
  233.             return ByteSequence( self.value + b.value )
  234.         raise TypeError( "expected string or ByteSequence as operand" )
  235.  
  236.     def __hash__( self ):
  237.         return self.value.hash()
  238.  
  239.  
  240. class Any:
  241.     "use only in connection with uno.invoke() to pass an explicit typed any"
  242.     def __init__(self, type, value ):
  243.         if isinstance( type, Type ):
  244.             self.type = type
  245.         else:
  246.             self.type = getTypeByName( type )
  247.         self.value = value
  248.  
  249. def invoke( object, methodname, argTuple ):
  250.     "use this function to pass exactly typed anys to the callee (using uno.Any)"
  251.     return pyuno.invoke( object, methodname, argTuple )
  252.     
  253. #---------------------------------------------------------------------------------------
  254. # don't use any functions beyond this point, private section, likely to change
  255. #---------------------------------------------------------------------------------------
  256. def _uno_import( name, *optargs ):
  257.     try:
  258. #       print "optargs = " + repr(optargs)
  259.         if len(optargs) == 0:
  260.            return _g_delegatee( name )
  261.            #print _g_delegatee
  262.         return _g_delegatee( name, *optargs )
  263.     except ImportError:
  264.         if len(optargs) != 3 or not optargs[2]:
  265.            raise
  266.     globals = optargs[0]
  267.     locals = optargs[1]
  268.     fromlist = optargs[2]
  269.     modnames = name.split( "." )
  270.     mod = None
  271.     d = sys.modules
  272.     for x in modnames:
  273.         if d.has_key(x):
  274.            mod = d[x]
  275.         else:
  276.            mod = pyuno.__class__(x)  # How to create a module ??
  277.         d = mod.__dict__
  278.  
  279.     RuntimeException = pyuno.getClass( "com.sun.star.uno.RuntimeException" )
  280.     for x in fromlist:
  281.        if not d.has_key(x):
  282.           if x.startswith( "typeOf" ):
  283.              try: 
  284.                 d[x] = pyuno.getTypeByName( name + "." + x[6:len(x)] )
  285.              except RuntimeException,e:
  286.                 raise ImportError( "type " + name + "." + x[6:len(x)] +" is unknown" )
  287.           else:
  288.             try:
  289.                 # check for structs, exceptions or interfaces
  290.                 d[x] = pyuno.getClass( name + "." + x )
  291.             except RuntimeException,e:
  292.                 # check for enums 
  293.                 try:
  294.                    d[x] = Enum( name , x )
  295.                 except RuntimeException,e2:
  296.                    # check for constants
  297.                    try:
  298.                       d[x] = getConstantByName( name + "." + x )
  299.                    except RuntimeException,e3:
  300.                       # no known uno type !
  301.                       raise ImportError( "type "+ name + "." +x + " is unknown" )
  302.     return mod
  303.  
  304. # hook into the __import__ chain    
  305. __builtin__.__dict__["__import__"] = _uno_import
  306.         
  307. # private function, don't use
  308. def _impl_extractName(name):
  309.     r = range (len(name)-1,0,-1)
  310.     for i in r:
  311.         if name[i] == ".":
  312.            name = name[i+1:len(name)]
  313.            break
  314.     return name            
  315.  
  316. # private, referenced from the pyuno shared library
  317. def _uno_struct__init__(self,*args):
  318.     if len(args) == 1 and hasattr(args[0], "__class__") and args[0].__class__ == self.__class__ :
  319.        self.__dict__["value"] = args[0]
  320.     else:
  321.        self.__dict__["value"] = pyuno._createUnoStructHelper(self.__class__.__pyunostruct__,args)
  322.     
  323. # private, referenced from the pyuno shared library
  324. def _uno_struct__getattr__(self,name):
  325.     return __builtin__.getattr(self.__dict__["value"],name)
  326.  
  327. # private, referenced from the pyuno shared library
  328. def _uno_struct__setattr__(self,name,value):
  329.     return __builtin__.setattr(self.__dict__["value"],name,value)
  330.  
  331. # private, referenced from the pyuno shared library
  332. def _uno_struct__repr__(self):
  333.     return repr(self.__dict__["value"])
  334.     
  335. def _uno_struct__str__(self):
  336.     return str(self.__dict__["value"])
  337.  
  338. # private, referenced from the pyuno shared library
  339. def _uno_struct__eq__(self,cmp):
  340.     if hasattr(cmp,"value"):
  341.        return self.__dict__["value"] == cmp.__dict__["value"]
  342.     return False
  343.  
  344. # referenced from pyuno shared lib and pythonscript.py
  345. def _uno_extract_printable_stacktrace( trace ):
  346.     mod = None
  347.     try:
  348.         mod = __import__("traceback")
  349.     except ImportError,e:
  350.         pass
  351.     ret = ""
  352.     if mod:
  353.         lst = mod.extract_tb( trace )
  354.         max = len(lst)
  355.         for j in range(max):
  356.             i = lst[max-j-1]
  357.             ret = ret + "  " + str(i[0]) + ":" + \
  358.                   str(i[1]) + " in function " + \
  359.                   str(i[2])  + "() [" + str(i[3]) + "]\n"
  360.     else:
  361.         ret = "Couldn't import traceback module"
  362.     return ret
  363.